1. Navigating to the Manage Object

Click on the left panel Settings menu and then click on the expanded Manage Object menu option.

Fig: 1 - Manage Object sub-menu option under the Settings menu option

Clicking on this menu option loads the Manage Object page showing the list of all objects from all modules existing in SurgeONE.ai. Here is the view of the loaded page.

Fig: 2 - Manage Object page

2. Understanding the various elements of the Manage Object page

Refer to the following screenshot which is marked with numerical values that correspond to the below stated points.

Fig: 3 - Understanding the various elements of the Manage Object page

1. Search bar to filter out objects
2. + Add Object button to create a new custom object
3. Grid view populates the loaded or filtered object(s) (system defined or custom)
4. ACTIONS column contains the toggled row-context menu options (for example: Edit, Manage Attributes, etc.)
5. Pagination options are provided at the bottom to control the grid items display limit and to navigate to other pages of the grid view entries

2.1. Searching for Objects

---

You can use the search bar to enter text and find matching objects.

Fig: 4 - Search bar to find existing objects

Based on the search query entered, matching object(s) are listed out.

Fig: 5 - Filtered results

The search query can be executed based on the content of other columns also. Here is the view of search operation executed on the basis of the CREATED ON column data.

Fig: 6 - Search operation executed on other columns data

If results are not found based on the search query, the grid displays the No matching records found label.

Fig: 7 - No matching records found

2.2. Creating a new Object

---

1. Click on the + Add Object button at the top right, to proceed to create a new object for your organization.

Fig: 8 - + Add Object button

A modal window loads where you need to specify the object details. Currently, the following fields are present:

• Object Label
• Object Name
• Description
• Logo
• Highlight Logo

Fig: 9 - Add Object modal window

2. Proceed to enter a suitable name for the new object in the Object Label field.

As you enter the name, the read-only (and disabled) Object Name field gets auto-populated with the same text.

Fig: 10 - Entered label getting auto-populated in the Object Name field

3. You can provide a suitable description as an optional step. Proceed to enter it in the Description field.

Fig: 11 - Entering object description

4. You can choose to attach relevant images in .svg format as the logo or its highlight using the Click to upload file button against the Logo and Highlight Logo fields respectively.

Fig: 12 - Options to choose and upload logo and highlight logo

5. Click on the Save button to create this new object as per the details specified in the modal window.
6. Get redirected to the Manage Object page. The new object gets added to the grid view.

2.3. Understanding the Manage Object grid view

---

The grid view displays all the existing objects from all the various applicable modules of SurgeONE.ai. The following columns are present to display the system defined and custom objects:

Fig: 15 - Manage Object grid view

1. OBJECT NAME: Displays the set label of the object
2. CREATION ON: Displays the date on which the object was created. The date format is [month name abbreviated to 3 letters] DD, YYYY.
3. CREATED BY: Displays the user the object was created by. For system defined objects, the Admin label populates the column.
4. STATUS: Displays the current status of the object to indicate whether it is in active state or inactive state
5. ACTIONS: Contains the vertical ellipsis icon which can be used to toggle the row-context menu option. The menu options differ between system defined and custom objects.

2.4. Using the ACTIONS column context menu options

---

The following sub-sections explain the functionalities of the various menu options toggled by clicking on the vertical ellipsis icon of the ACTIONS column. The menu options differ between system defined and custom objects.

Here is the view of the menu options for system defined objects.

Fig: 16 - Menu options for system defined objects

Here is the view of the menu options for custom objects.

Fig: 17 - Menu options for custom objects

2.4.1. Using the Edit context menu option

---

1. To edit an object (either system defined or custom), click on the vertical ellipsis icon of the ACTIONS column against the row entry of the object which you wish to edit. Click on the expanded Edit menu option to proceed to edit an existing object.

Fig: 18 - Edit option to edit object

2. The following Edit Object modal window loads. The following fields are present:
   • Object Label
   • Object Name
   • Description
   • Logo
   • Highlight Logo

Fig: 19 - Edit Object modal window

3. Make necessary changes to the labels of the Object Label and Description fields. You cannot modify the value of the Object Name field. The Description field is optional and can be left blank.
4. You can choose to attach relevant images in .svg format as the logo or its highlight using the Click to upload file button against the Logo and Highlight Logo fields respectively.
5. Click on the Save button to store your changes.

Fig: 20 - Saving changes

6. Get redirected to the Manage Object page. The changes are reflected on the list page for the selected object.

2.4.2. Using the Manage Attribute context menu option

---

1. To manage object attributes, click on the vertical ellipsis icon of the ACTIONS column against the row entry of the object. Click on the expanded Manage Attribute menu option to proceed to the object attributes page.

Fig: 21 - Manage Attribute context menu option

2. The following attributes page loads. The attributes associated with the source object populate the grid view.

Fig: 22 - Apps > Attributes page

2.4.3. Using the Form Details context menu option

---

1. To set or manage form details, click on the vertical ellipsis icon of the ACTIONS column against the row entry of the object. Click on the expanded Form Details menu option to proceed to the respective page.

Fig: 23 - Form Details context menu option

2. The following page loads.

Fig: 24 - Form Details page

2.4.4. Using the In-Active context menu option

---

1. To set or manage form details, click on the vertical ellipsis icon of the ACTIONS column against the row entry of the object. Click on the expanded In-Active menu option to proceed to deactive the custom object.

Fig: 25 - In-Active context menu option

2. Get redirected to the grid view first page. The label of the STATUS column changes from Active to Inactive for the custom object. Notice that, the menu option label also changes to Active. Clicking on it changes the status to default active state.

Fig: 26 - Menu option and status label changes

2.5. Manage Object pagination options

---

Pagination options are provided at the bottom. The page items count can be set at either 10, 25, 50 or 100. Use the arrow icons to navigate through multiple pages of objects, which populate the grid view as per the selected count of items per page.

Fig: 27 - Manage Object pagination options

3. Understanding the various elements of the Manage Attributes page

The Attributes page enlists all the system (pre-defined) and custom (user-defined) attributes for the existing objects of SurgeONE.ai.

Refer to the following screenshot which is marked with numerical values that correspond to the below stated points.

Fig: 28 - Understanding the various elements of the Manage Attributes page

1. Search bar to filter out attributes
2. Dropdown to select object. It displays the object label which was used to navigate to this page.
3. Category dropdown to select system defined or custom attribute (which populates the grid view)
4. + Add Attribute button to create a new custom attribute
5. Grid view populates the loaded or filtered attribute(s) (system defined or custom) of the chosen object
6. ACTIONS column contains the toggled row-context menu option(s).
   • Currently, only the Edit option is provided for system defined attributes. The system attributes cannot be deleted.
   • The Edit and Delete options are provided for custom attributes. The Delete option is present for an attribute which is not referenced elsewhere.
7. Pagination options are provided at the bottom to control the grid items display limit and to navigate to other pages of the grid view entries

3.1. Searching for Attributes of an Object

---

You can use the search bar to enter text and find matching attributes which belong to the chosen object.

Based on the search query entered, matching attribute(s) are listed out in the grid view, after quick search operation.

Fig: 29 - Filtered results

The search query can be executed based on the content of other columns also. Here is the view of search operation executed on the basis of the CREATED ON column data.

Fig: 30 - Search operation executed on other columns data

If results are not found based on the search query, the grid displays the No matching records found label.

Fig: 31 - No matching records found

3.2. Loading Attributes based on Object filter selection

---

You can use the object selection dropdown, which exists beside the search bar, to select any existing object (system defined or custom).

By default, the dropdown is set to the object which was referenced to navigate to the attributes page. You can change the selection to any other listed object. Multi-selection is not permitted.

Fig: 32 - Object selection dropdown to filter results or load attributes of another object

Based on the object selection made, the associated attributes populate the grid view.

Fig: 33 - Selecting an object to load its attributes

3.3. Filtering Attributes based on Category filter selection

---

You can use the category selection dropdown, which exists at the right side of the object selection dropdown, to filter out attributes on the basis of origin - that is, whether it the attributes are system defined or custom.

By default, the dropdown is set to All Catogory. You can change the selection to the other options - System or Custom. Multi-selection is not permitted.

Fig: 34 - Category selection dropdown options

Based on the category selection made, the associated attributes populate the grid view. The following screenshot displays the system defined attributes for the Apps object, since the System dropdown option is set.

Fig: 35 - Filtering system defined attributes

Fig: 36 - Filtering system defined attributes

3.4. Creating a new Custom Attribute

---

1. Click on the + Add Attribute button at the top right, to proceed to create a new custom attribute for the chosen object.

Fig: 37 - + Add Attribute button

A modal window loads where you need to specify the new custom attribute details. Currently, the following fields are present:

• Object Name - Greyed-out field (displays the associated object label)
• Label - Mandatory field
• Name - Greyed-out field
• Type - Mandatory dropdown field
• Description - Optional field
• Section / Group - Mandatory dropdown field
• Visible in Form - Enabled by default, editable slider
• Mandatory - Disabled by default, editable slider
• Read-Only - Disabled by default, editable slider
• Editable in Edit Mode - Disabled by default, editable slider

Fig: 38 - Add Attribute modal window

2. Proceed to enter a suitable name for the new attribute in the Label field.

As you enter the name, the read-only (and disabled) Name field gets auto-populated with the same text.

Fig: 39 - Entered label getting auto-populated in the Name field

3. Choose a suitable option from the Type dropdown. Four options are provided labeled as - Text, Number, Decimal and Date. The selection defines the value type of the attribute being created.

Fig: 40 - Type dropdown options

4. You can provide a suitable description as an optional step. Proceed to enter it in the Description field.

Fig: 41 - Entering attribute description

5. Next, choose a section or group for the new attribute. There are two methods of doing it - either by selecting an existing dropdown option or by creating a new one. Refer to the following screenshot with numerical markings indicated on it, depicting the two methods - which have been explained in the following two bullet points respectively.

Fig: 42 - Methods of choosing section / group

5.1. Selecting an existing dropdown option

---

• The option(s) populate the dropdown depending on the object. For example, since the attributes of the Device object was selected, the Section / Group dropdown contains the Device Information option (visible in the following image).

Fig: 43 - Dropdown option

5.2. Creating a new dropdown option

---

• Click on the add or plus icon (located at the right of the Section / Group dropdown) to proceed to create a new section / group.

Fig: 44 - Clicking on Add icon to begin creating new section / group

An Add Group modal window loads. Enter a suitable new section / group label in the input field and click on the Save button.

Fig: 45 - Creating a new section / group

After you create the new section / group, it populates the Section / Group dropdown.

Fig: 46 - Created new section / group visible as dropdown option

6. Finally, you may choose to select / deselect the slider options provided. There are four sliders provided, as follows:
   • Visible In Form
   • Mandatory
   • Read-Only
   • Editable In Edit Mode

   Fig: 47 - Configurable sliders

   The first slider is enabled by default, while the rest are disabled by default.

7. After sliders are set accordingly, click on the Save button to create this new attribute as per the details specified in the modal window.

Fig: 48 - Saving details to create a new custom attribute

8. Get redirected to the [Object name] > Attributes page. The new attribute gets added to the grid view.

3.5. Understanding the Attributes grid view

---

The grid view displays all the existing attributes of the various (chosen / applicable) objects of SurgeONE.ai. The following columns are present to display the system defined and custom attributes:

Fig: 53 - Manage Attributes grid view

1. ATTRIBUTE LABEL: Displays the set label of the attribute
2. ATTRIBUTE TYPE: Displays the type of the attribute. The type can be either one of the follows: Text, Number, Decimal or Date.
3. CATEGORY: Displays the category which an attribute belongs to. By default, all catogories are displayed. You can change the selection to the other options - System or Custom by using the category selection dropdown at the top. Multi-selection is not permitted. For system defined attributes, a System label populates the column, while for user defined attributes, a Custom label populates the column.
4. SECTION/GROUP: Displays the section or group the attribute is part of. It can be either system defined section / group name or it can be set to a custom user defined section / group label.
5. CREATED ON: Displays the date on which the attribute was created. The date format is [month name abbreviated to 3 letters] DD, YYYY.
6. ACTIONS: Contains the vertical ellipsis icon which can be used to toggle the row-context menu option. The menu options differ between system defined and custom attributes.

3.6. Using the ACTIONS column context menu options

---

The following sub-sections explain the functionalities of the various menu options toggled by clicking on the vertical ellipsis icon of the ACTIONS column. The menu options differ between system defined and custom objects.

Here is the view of the menu options for system defined objects.

Fig: 54 - Menu options for system defined objects

Here is the view of the menu options for custom objects.

Fig: 55 - Menu options for custom objects

3.6.1. Editing a System Attribute

---

1. To edit any existing system attribute, click on the vertical ellipsis icon of the ACTIONS column against the row entry. Click on the expanded Edit menu option.

Fig: 56 - Edit option to edit system attribute

2. The following Edit Attribute modal window loads. The following fields are present:
   • Object Name - Disabled, non-editable field
   • Label - Editable, mandatory field
   • Name - Disabled field, however it updates when the above Label field is updated
   • Type - Non-editable field
   • Description - Editable, non-mandatory field
   • Section / Group - Non-editable dropdown
   • Visible in Form - Disabled, non-editable slider
   • Mandatory - Disabled, non-editable slider
   • Read-Only - Disabled, non-editable slider
   • Editable in Edit Mode - Enabled, non-editable slider

Fig: 57 - Edit option to edit system attribute

3. Make necessary changes to the labels of the Label and Description fields. Editing a system attribute is restricted to only changing the label and the description. You cannot modify any other properties for a system attribute. The Description field is optional and can be left blank.
4. Click on the Save button to store your changes.

3.6.2. Editing a Custom Attribute

---

1. To edit any existing custom attribute, click on the vertical ellipsis icon of the ACTIONS column against the row entry. Click on the expanded Edit menu option.

Fig: 58 - Edit option to edit custom attribute

2. The following Edit Attribute modal window loads. The following fields are present:
   • Object Name - Disabled, non-editable field
   • Label - Editable, mandatory field
   • Name - Disabled field, however it updates when the above Label field is updated
   • Type - Non-editable field
   • Description - Editable, non-mandatory field
   • Section / Group - Editable dropdown, with the option to create a new custom section / group
   • Visible in Form - Editable slider
   • Mandatory - Editable slider
   • Read-Only - Editable slider
   • Editable in Edit Mode - Editable slider

Fig: 59 - Edit option to edit custom attribute

3. Make necessary changes to the labels of the Label and Description fields. The Description field is optional and can be left blank. For a custom attribute, only the Object Name and the attribute Type cannot be modified. The rest of the fields, including the sliders can be modified. A new section / group can also be created and set.
4. Click on the Save button to store your changes.

3.6.3. Deleting a Custom Attribute

---

Let us consider that the following custom attribute is to be deleted.

Fig: 60 - Sample custom attribute to be deleted

1. To delete it, click on the vertical ellipsis icon of the ACTIONS column against the row entry of the object. Click on the expanded Delete menu option to proceed to remove the object attribute.

Fig: 61 - Delete context menu option

2. The following confirmation prompt loads. Click on the Yes to confirm the delete operation.

Fig: 62 - Attribute deletion confirmation prompt

3. The attribute gets deleted and cannot be found.

Fig: 63 - Custom attribute deleted

3.7. Manage Attributes pagination options

---

Pagination options are provided at the bottom. The page items count can be set at either 10, 25, 50 or 100. Use the arrow icons to navigate through multiple pages of attributes, which populate the grid view as per the selected count of items per page.

Fig: 64 - Manage Attributes pagination options

4. Navigating to the Form Details page

To navigate to the Form Details (or the Form Design page), click on the expanded Form Details row content menu option (against a custom object).

Fig: 65 - Form Details menu option

Depending on the custom object, this page may contain an already pre-designed form or may be blank. Consider the following screenshot where the page contains form elements.

Fig: 66 - Form Design page with configured form elements

The following screenshot displays a blank page. Since it is blank, the Add Step modal window loads by default.

Fig: 67 - Blank Form Design page with no configured form elements

4.1. Designing a new Form

---

Designing a new form can consist of multiple steps. There can be four types of steps, as follows:

1. Form
2. Template Selection
3. Mail Selection
4. User Selection

The following sub-sections elaborate on the process of adding each of these step types.

4.1.1. Adding a Form Step and Configuring it

---

Let us consider that the Form type of step is to be created.

1. Click on the + Add Step button to load the Add Step modal window (if it is not yet prompted by the system).

Fig: 68 - Add Step modal window

2. Enter a suitable section name in the Step Name field.
3. After that, you can enter an appropriate desciption in the Step Description field.
4. Finally, select the Form option of the Step Type dropdown.

Fig: 69 - Form option

5. Click on the Save button.

Fig: 70 - Saving a new Form Step

6. The step gets added into the form. Refer to the following screenshot which displays it, along with the sections to select attributes or set up the form details or layout.

Fig: 71 - Added Form Step

Now let us understand the various functionalities which are present in the added Form step type.

On the left section labeled as Select Attribute you can find the various selectable attributes which can be included in the Form.

Fig: 72 - Select Attribute section

1. Click on the plus (+) icon or drag the attribute into the Form Details section.

Fig: 73 - Selected Attributes included into the Form Details section

2. You can also click on the Form Preview button to view the actual representation of the form.

Fig: 74 - Previewing Form

3. You can click on the arrow (up and down) icons to move and arrange the included attributes of the Form Details section. Refer to the following screenshot where the Status attribute is moved down using the down arrow icon.

Fig: 75 - Arranging attributes in the Form

4. Click on the delete icon to remove any included attribute. After clicking on it, the previously included attribute gets moved from the Form Details section to the Select Attributes section.

Fig: 76 - Removing an included attribute from the Form

5. To save your changes as a draft copy, click on the Save button.

Fig: 77 - Save button

6. To make your changes live, click on the Publish button.

Fig: 78 - Publish button

4.1.2. Adding a Template Selection Step and Configuring it

---

Let us consider that the Template Selection type of step is to be created.

1. Click on the + Add Step button to load the Add Step modal window.
2. Enter a suitable section name in the Step Name field.
3. After that, you can enter an appropriate desciption in the Step Description field.
4. Finally, select the Template Selection option of the Step Type dropdown.
5. Click on the Save button.

Fig: 79 - Saving a new Template Selection Step

6. The step gets added into the form. Refer to the following screenshot which displays it, along with the section to select template.

Fig: 80 - Added Template Selection Step

Now let us understand the various functionalities which are present in the added Template Selection step type.

1. Click on the plus (+) icon or drag the template into the Form Details section.

Fig: 81 - Selected Template included into the Form Details section

2. Click on the delete icon to remove any included template. After clicking on it, the previously included template gets moved from the Form Details section to the Select Template section.

Fig: 82 - Removing an included Template from the Form

3. To save your changes as a draft copy, click on the Save button.
4. To make your changes live, click on the Publish button.

4.1.3. Adding a Mail Selection Step and Configuring it

---

Let us consider that the Mail Selection type of step is to be created.

1. Click on the + Add Step button to load the Add Step modal window.
2. Enter a suitable section name in the Step Name field.
3. After that, you can enter an appropriate desciption in the Step Description field.
4. Finally, select the Mail Selection option of the Step Type dropdown.
5. Click on the Save button.

Fig: 83 - Saving a new Mail Selection Step

6. The step gets added into the form. Refer to the following screenshot which displays it, along with the section to select mail template.

Fig: 84 - Added Mail Selection Step

Now let us understand the various functionalities which are present in the added Mail Selection step type.

1. Click on the plus (+) icon or drag the mail template into the Form Details section.

Fig: 85 - Selected Mail Template included into the Form Details section

2. Click on the delete icon to remove any included mail template. After clicking on it, the previously included mail template gets moved from the Form Details section to the Select MailTemplate section.

Fig: 86 - Removing an included Mail Template from the Form

3. To save your changes as a draft copy, click on the Save button.
4. To make your changes live, click on the Publish button.

4.1.4. Adding a User Selection Step and Configuring it

---

Let us consider that the User Selection type of step is to be created.

1. Click on the + Add Step button to load the Add Step modal window.
2. Enter a suitable section name in the Step Name field.
3. After that, you can enter an appropriate desciption in the Step Description field.
4. Finally, select the User Selection option of the Step Type dropdown.
5. Click on the Save button.

Fig: 87 - Saving a new User Selection Step

6. The step gets added into the form. Refer to the following screenshot which displays it, along with the section to select user template.

Fig: 88 - Added User Selection Step

Now let us understand the various functionalities which are present in the added User Selection step type.

1. Click on the plus (+) icon or drag the listed user(s) from the Select User section into the Form Details section.

Fig: 89 - Selected users included into the Form Details section

2. Click on the delete icon to remove any included user. After clicking on it, the previously included user gets moved from the Form Details section to the Select User section.

Fig: 90 - Removing an included Mail Template from the Form

3. To save your changes as a draft copy, click on the Save button.
4. To make your changes live, click on the Publish button.

4.2. Understanding the various elements of the Form Details or Form Design page

---

Refer to the following screenshot which is marked with numerical values that correspond to the below stated points.

Fig: 92 - Various elements of the form design page

1. The top Form Design label displays the object label for which the form is being created or updated.
2. The top section step cards below it display the step number and label.
3. The edit icon on the step card can be used to modify the step name and step desciption. Clicking on the edit icon loads the following Edit Step modal window. The Step Name and Step Description fields can be updated. The Step Type field is disabled and cannot be modified. Click on the Update button to store any changes done.

Fig: 93 - Editing step details

4. The delete icon on the step card can be used to remove the step. Removing a step does not alter the step numbers of any other step cards which are present beside it.
5. The + Add Step button can be used to create a new step (as already explained in this section).
6. The element(s) present on the left side panel section can be included in the Form Details section either by clicking on the plus (+) icon beside the respective element, or by dragging it into the Form Details section. The selectable elements depend on the step type. For example, the User Selection step type contains the Select User left panel section with selectable list of users, while the Form step type contains the Select Attribute left panel section with selectable list of attributes.
7. The middle panel contains the Form Details section. Any elements included from the left panel section populate this Form Details section. A delete icon present on the right side of any included element. The delete icon can be used to remove it from this section and move it back to the left panel section.
8. The Configure section on the right side panel is to modify the selected element. Currently, the functionality is not enabled.
9. The Save button can be used to save the created or edited form. A success notification gets triggered.

Fig: 94 - Success notification after saving

10. The Publish button can be used to publish the created or edited form. After you click on it, a confirmation modal pops up. Click on the Yes button to confirm.

Fig: 95 - Confirmation modal for publishing

A success notification gets triggered.

Fig: 96 - Success notification after publishing

---